Custom Field Service

This service is used to store and read customer-specific fields and their contents.

LoadCustomFields

This method loads the customer-specific fields and the contents for a transferred master data record.

void LoadCustomFields(  
 out TpFault fault,  
 TpAuthentication authentication,  
 SourceData sourceData,  
 Guid sourceDataId,  
 out ListCustomFieldContentDto> customFieldContent,  
 out List<CustomFieldDto> customFields);

Needed Permission	customFields@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
sourceData		Defines the source data (Employee, Project, Task, Customer, ActiveTimeEntry, TimeEntry, Team, Department, Branch, MonthlySummary)
sourceDataId		Unique id of the source data
customFieldContent	Out	Content of the defined custom fields
customFields	Out	All custom fields that are defined

ReportCustomFields

This method loads the customer-specific fields and the content for a transferred master data record with the aim of using these fields for reporting.

void ReportCustomFields(  
 out TpFault fault,  
 TpAuthentication authentication,  
 SourceData sourceData,  
 Guid sourceDataId,  
 out List<CustomFieldContentDto> customFieldContent,  
 out List<CustomFieldDto> customFields);

Needed Permission	customFields@report
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
sourceData		Defines the source data (Employee, Project, Task, Customer, ActiveTimeEntry, TimeEntry, Team, Department, Branch, MonthlySummary)
sourceDataId		Unique id of the source data
customFieldContent	Out	Content of the defined custom fields
customFields	Out	All custom fields that are defined

SaveCustomFields

This method is used to store customer-specific fields. However, you cannot create new customer-specific fields with this method, you can only fill them.

void SaveCustomFields(  
 out TpFault fault,  
 TpAuthentication authentication,  
 SourceData sourceData,  
 Guid sourceDataId,  
 List<CustomFieldContentDto> customFieldContent);

Needed Permission	customFields@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
sourceData		Defines the source data (Employee, Project, Task, Customer, ActiveTimeEntry, TimeEntry, Team, Department, Branch, MonthlySummary)
sourceDataId		Unique id of the source data
customFieldContent	Out	Content of the defined custom fields

LoadCustomFieldDefinitions

This method loads the actual customer-specific fields for processing.

List<CustomFieldDto> LoadCustomFieldDefinitions(  
 out TpFault fault,  
 TpAuthentication authentication,  
 SourceData sourceData);

Needed Permission	customFields@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
sourceData		Defines the source data (Employee, Project, Task, Customer, ActiveTimeEntry, TimeEntry, Team, Department, Branch, MonthlySummary)
Return value	Out	All custom fields that are defined

SaveCustomFieldDefinitions

This method stores the customer-specific fields. This allows new fields to be created and existing field definitions to be adjusted.

void SaveCustomFieldDefinitions(  
 out TpFault fault,  
 TpAuthentication authentication,  
 SourceData sourceData,  
 List<CustomFieldDto> customFields);

Needed Permission	customFields@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
sourceData		Defines the source data (Employee, Project, Task, Customer, ActiveTimeEntry, TimeEntry, Team, Department, Branch, MonthlySummary)
customFields		All custom fields that are defined